|
| 1 | +package io.temporal.common.converter; |
| 2 | + |
| 3 | +import static org.junit.Assert.assertEquals; |
| 4 | +import static org.junit.Assert.assertTrue; |
| 5 | + |
| 6 | +import com.fasterxml.jackson.databind.ObjectMapper; |
| 7 | +import io.temporal.api.common.v1.Payload; |
| 8 | +import java.time.Instant; |
| 9 | +import java.util.Objects; |
| 10 | +import java.util.Optional; |
| 11 | +import org.junit.After; |
| 12 | +import org.junit.Test; |
| 13 | +import tools.jackson.databind.json.JsonMapper; |
| 14 | + |
| 15 | +public class Jackson3JsonPayloadConverterTest { |
| 16 | + |
| 17 | + @After |
| 18 | + public void resetJackson3Delegate() { |
| 19 | + JacksonJsonPayloadConverter.setDefaultAsJackson3(false, false); |
| 20 | + } |
| 21 | + |
| 22 | + @Test |
| 23 | + public void testSimple() { |
| 24 | + Jackson3JsonPayloadConverter converter = new Jackson3JsonPayloadConverter(); |
| 25 | + TestPayload payload = new TestPayload(1L, Instant.now(), "myPayload"); |
| 26 | + Optional<Payload> data = converter.toData(payload); |
| 27 | + assertTrue(data.isPresent()); |
| 28 | + |
| 29 | + // Jackson 3 native defaults sort fields alphabetically (id, name, timestamp) |
| 30 | + // unlike jackson2Compat which preserves declaration order (id, timestamp, name) |
| 31 | + String json = data.get().getData().toStringUtf8(); |
| 32 | + assertTrue( |
| 33 | + "Expected alphabetical field order (Jackson 3 native), got: " + json, |
| 34 | + json.indexOf("\"name\"") < json.indexOf("\"timestamp\"")); |
| 35 | + |
| 36 | + TestPayload converted = converter.fromData(data.get(), TestPayload.class, TestPayload.class); |
| 37 | + assertEquals(payload, converted); |
| 38 | + } |
| 39 | + |
| 40 | + @Test |
| 41 | + public void testSimpleJackson2Compat() { |
| 42 | + Jackson3JsonPayloadConverter converter = new Jackson3JsonPayloadConverter(true); |
| 43 | + TestPayload payload = new TestPayload(1L, Instant.now(), "myPayload"); |
| 44 | + Optional<Payload> data = converter.toData(payload); |
| 45 | + assertTrue(data.isPresent()); |
| 46 | + |
| 47 | + // jackson2Compat preserves declaration order (id, timestamp, name) |
| 48 | + // unlike Jackson 3 native which sorts alphabetically (id, name, timestamp) |
| 49 | + String json = data.get().getData().toStringUtf8(); |
| 50 | + assertTrue( |
| 51 | + "Expected declaration field order (jackson2Compat), got: " + json, |
| 52 | + json.indexOf("\"timestamp\"") < json.indexOf("\"name\"")); |
| 53 | + |
| 54 | + TestPayload converted = converter.fromData(data.get(), TestPayload.class, TestPayload.class); |
| 55 | + assertEquals(payload, converted); |
| 56 | + } |
| 57 | + |
| 58 | + @Test |
| 59 | + public void testCustomJsonMapper() { |
| 60 | + JsonMapper mapper = |
| 61 | + Jackson3JsonPayloadConverter.newDefaultJsonMapper(false) |
| 62 | + .rebuild() |
| 63 | + .enable(tools.jackson.databind.SerializationFeature.INDENT_OUTPUT) |
| 64 | + .build(); |
| 65 | + Jackson3JsonPayloadConverter converter = new Jackson3JsonPayloadConverter(mapper); |
| 66 | + TestPayload payload = new TestPayload(1L, Instant.now(), "test"); |
| 67 | + Optional<Payload> data = converter.toData(payload); |
| 68 | + assertTrue(data.isPresent()); |
| 69 | + String json = data.get().getData().toStringUtf8(); |
| 70 | + assertTrue("Expected pretty-printed JSON", json.contains("\n")); |
| 71 | + } |
| 72 | + |
| 73 | + @Test |
| 74 | + public void testEncodingType() { |
| 75 | + Jackson3JsonPayloadConverter converter = new Jackson3JsonPayloadConverter(); |
| 76 | + assertEquals("json/plain", converter.getEncodingType()); |
| 77 | + } |
| 78 | + |
| 79 | + @Test |
| 80 | + public void testWireCompatibilityBetweenJackson2AndJackson3() { |
| 81 | + JacksonJsonPayloadConverter jackson2 = new JacksonJsonPayloadConverter(); |
| 82 | + Jackson3JsonPayloadConverter jackson3 = new Jackson3JsonPayloadConverter(true); |
| 83 | + |
| 84 | + TestPayload payload = new TestPayload(42L, Instant.parse("2024-01-15T10:30:00Z"), "wireTest"); |
| 85 | + |
| 86 | + // Jackson 2 serialized -> Jackson 3 deserialized |
| 87 | + Optional<Payload> data2 = jackson2.toData(payload); |
| 88 | + assertTrue(data2.isPresent()); |
| 89 | + assertEquals(payload, jackson3.fromData(data2.get(), TestPayload.class, TestPayload.class)); |
| 90 | + |
| 91 | + // Jackson 3 serialized -> Jackson 2 deserialized |
| 92 | + Optional<Payload> data3 = jackson3.toData(payload); |
| 93 | + assertTrue(data3.isPresent()); |
| 94 | + assertEquals(payload, jackson2.fromData(data3.get(), TestPayload.class, TestPayload.class)); |
| 95 | + } |
| 96 | + |
| 97 | + @Test |
| 98 | + public void testSetDefaultAsJackson3() { |
| 99 | + JacksonJsonPayloadConverter.setDefaultAsJackson3(true, false); |
| 100 | + |
| 101 | + Optional<Payload> data = |
| 102 | + GlobalDataConverter.get().toPayload(new TestPayload(1L, Instant.now(), "delegated")); |
| 103 | + assertTrue(data.isPresent()); |
| 104 | + |
| 105 | + // Alphabetical field order proves Jackson 3 native is being used |
| 106 | + String json = data.get().getData().toStringUtf8(); |
| 107 | + assertTrue( |
| 108 | + "Expected alphabetical field order (Jackson 3 native), got: " + json, |
| 109 | + json.indexOf("\"name\"") < json.indexOf("\"timestamp\"")); |
| 110 | + } |
| 111 | + |
| 112 | + @Test |
| 113 | + public void testSetDefaultAsJackson3WithCompat() { |
| 114 | + JacksonJsonPayloadConverter.setDefaultAsJackson3(true, true); |
| 115 | + |
| 116 | + Optional<Payload> data = |
| 117 | + GlobalDataConverter.get().toPayload(new TestPayload(1L, Instant.now(), "delegated-compat")); |
| 118 | + assertTrue(data.isPresent()); |
| 119 | + |
| 120 | + // Declaration field order proves Jackson 3 with jackson2Compat is being used |
| 121 | + String json = data.get().getData().toStringUtf8(); |
| 122 | + assertTrue( |
| 123 | + "Expected declaration field order (jackson2Compat), got: " + json, |
| 124 | + json.indexOf("\"timestamp\"") < json.indexOf("\"name\"")); |
| 125 | + } |
| 126 | + |
| 127 | + @Test |
| 128 | + public void testExplicitObjectMapperIgnoresJackson3Delegate() { |
| 129 | + // Enable Jackson 3 native globally (which sorts fields alphabetically) |
| 130 | + JacksonJsonPayloadConverter.setDefaultAsJackson3(true, false); |
| 131 | + |
| 132 | + // Converter created with explicit ObjectMapper should NOT delegate to Jackson 3 |
| 133 | + ObjectMapper mapper = JacksonJsonPayloadConverter.newDefaultObjectMapper(); |
| 134 | + JacksonJsonPayloadConverter converter = new JacksonJsonPayloadConverter(mapper); |
| 135 | + |
| 136 | + TestPayload payload = new TestPayload(1L, Instant.now(), "explicit"); |
| 137 | + Optional<Payload> data = converter.toData(payload); |
| 138 | + assertTrue(data.isPresent()); |
| 139 | + |
| 140 | + // Declaration field order proves Jackson 2 is still being used, not the Jackson 3 delegate |
| 141 | + String json = data.get().getData().toStringUtf8(); |
| 142 | + assertTrue( |
| 143 | + "Expected declaration field order (Jackson 2), got: " + json, |
| 144 | + json.indexOf("\"timestamp\"") < json.indexOf("\"name\"")); |
| 145 | + } |
| 146 | + |
| 147 | + static class TestPayload { |
| 148 | + private long id; |
| 149 | + private Instant timestamp; |
| 150 | + private String name; |
| 151 | + |
| 152 | + public TestPayload() {} |
| 153 | + |
| 154 | + TestPayload(long id, Instant timestamp, String name) { |
| 155 | + this.id = id; |
| 156 | + this.timestamp = timestamp; |
| 157 | + this.name = name; |
| 158 | + } |
| 159 | + |
| 160 | + public long getId() { |
| 161 | + return id; |
| 162 | + } |
| 163 | + |
| 164 | + public void setId(long id) { |
| 165 | + this.id = id; |
| 166 | + } |
| 167 | + |
| 168 | + public Instant getTimestamp() { |
| 169 | + return timestamp; |
| 170 | + } |
| 171 | + |
| 172 | + public void setTimestamp(Instant timestamp) { |
| 173 | + this.timestamp = timestamp; |
| 174 | + } |
| 175 | + |
| 176 | + public String getName() { |
| 177 | + return name; |
| 178 | + } |
| 179 | + |
| 180 | + public void setName(String name) { |
| 181 | + this.name = name; |
| 182 | + } |
| 183 | + |
| 184 | + @Override |
| 185 | + public boolean equals(Object o) { |
| 186 | + if (this == o) { |
| 187 | + return true; |
| 188 | + } |
| 189 | + if (o == null || getClass() != o.getClass()) { |
| 190 | + return false; |
| 191 | + } |
| 192 | + TestPayload that = (TestPayload) o; |
| 193 | + return id == that.id |
| 194 | + && Objects.equals(timestamp, that.timestamp) |
| 195 | + && Objects.equals(name, that.name); |
| 196 | + } |
| 197 | + |
| 198 | + @Override |
| 199 | + public int hashCode() { |
| 200 | + return Objects.hash(id, timestamp, name); |
| 201 | + } |
| 202 | + |
| 203 | + @Override |
| 204 | + public String toString() { |
| 205 | + return "TestPayload{" |
| 206 | + + "id=" |
| 207 | + + id |
| 208 | + + ", timestamp=" |
| 209 | + + timestamp |
| 210 | + + ", name='" |
| 211 | + + name |
| 212 | + + '\'' |
| 213 | + + '}'; |
| 214 | + } |
| 215 | + } |
| 216 | +} |
0 commit comments