Skip to content

Commit 63f36b8

Browse files
jeanouiijeanouii
committed
fix(JOHNZON-426): BigInteger/BigDecimal string adapter flags swapped
fix(JOHNZON-427): BigDecimal/BigInteger READ/WRITE not consistent Signed-off-by: Jean-Louis Monteiro <jlmonteiro@tomitribe.com>
1 parent 67bb7a1 commit 63f36b8

File tree

7 files changed

+127
-7
lines changed

7 files changed

+127
-7
lines changed

‎johnzon-mapper/src/main/java/org/apache/johnzon/mapper/MapperBuilder.java‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -529,6 +529,16 @@ public MapperBuilder setUseJsRange(boolean value) {
529529
return this;
530530
}
531531

532+
public MapperBuilder setUseBigIntegerStringAdapter(final boolean convertBigIntegerToString) {
533+
adapters.setUseBigIntegerStringAdapter(convertBigIntegerToString);
534+
return this;
535+
}
536+
537+
public MapperBuilder setUseBigDecimalStringAdapter(final boolean convertBigDecimalToString) {
538+
adapters.setUseBigDecimalStringAdapter(convertBigDecimalToString);
539+
return this;
540+
}
541+
532542
public MapperBuilder setUseBigDecimalForObjectNumbers(final boolean value) {
533543
this.useBigDecimalForObjectNumbers = value;
534544
return this;

‎johnzon-mapper/src/main/java/org/apache/johnzon/mapper/Mappings.java‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -681,6 +681,12 @@ private MapperConverter findConverter(final boolean copyDate, final AccessMode.D
681681

682682
if (Date.class.isAssignableFrom(type) && copyDate) {
683683
converter = new DateWithCopyConverter(Adapter.class.cast(adapters.get(new AdapterKey(Date.class, String.class))));
684+
} else if (type == BigDecimal.class || type == BigInteger.class) {
685+
// BigDecimal/BigInteger are "primitives" in the mapper so they bypass
686+
// config.findAdapter() in writeValue(). Use a direct get() to trigger
687+
// lazy loading and respect useBigDecimalStringAdapter/useBigIntegerStringAdapter.
688+
// this makes it symetric with READ
689+
converter = adapters.get(new AdapterKey(type, String.class));
684690
} else {
685691
for (final Map.Entry<AdapterKey, Adapter<?, ?>> adapterEntry : adapters.entrySet()) {
686692
if (adapterEntry.getKey().getFrom() == adapterEntry.getKey().getTo()) { // String -> String

‎johnzon-mapper/src/main/java/org/apache/johnzon/mapper/converter/BigDecimalConverter.java‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,9 @@
2525
public class BigDecimalConverter implements Converter<BigDecimal> {
2626
@Override
2727
public String toString(final BigDecimal instance) {
28-
return instance.toString();
28+
// when using the converter, user expects the decimal notation
29+
// otherwise, JsonNumber will give the E (scientific) notation
30+
return instance.toPlainString();
2931
}
3032

3133
@Override

‎johnzon-mapper/src/main/java/org/apache/johnzon/mapper/map/LazyConverterMap.java‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,11 @@ public Object from(final Object a) {
8585

8686
private boolean useShortISO8601Format = true;
8787
private DateTimeFormatter dateTimeFormatter;
88+
// I-JSON (RFC 7493 Section 2.2): BigX exceed IEEE 754 double, string is safer by default.
89+
// Set -Djohnzon.use-ijson-big-number-stringadapter.disabled=true for strict JSON-B 3.0 / TCK compliance.
90+
private static final boolean IJSON_BIG_NUMBER_DEFAULT = !Boolean.getBoolean("johnzon.use-ijson-big-number-stringadapter.disabled");
91+
private boolean useBigIntegerStringAdapter = IJSON_BIG_NUMBER_DEFAULT;
92+
private boolean useBigDecimalStringAdapter = IJSON_BIG_NUMBER_DEFAULT;
8893

8994
public void setUseShortISO8601Format(final boolean useShortISO8601Format) {
9095
this.useShortISO8601Format = useShortISO8601Format;
@@ -94,6 +99,14 @@ public void setDateTimeFormatter(final DateTimeFormatter dateTimeFormatter) {
9499
this.dateTimeFormatter = dateTimeFormatter;
95100
}
96101

102+
public void setUseBigDecimalStringAdapter(final boolean useBigDecimalStringAdapter) {
103+
this.useBigDecimalStringAdapter = useBigDecimalStringAdapter;
104+
}
105+
106+
public void setUseBigIntegerStringAdapter(final boolean useBigIntegerStringAdapter) {
107+
this.useBigIntegerStringAdapter = useBigIntegerStringAdapter;
108+
}
109+
97110
@Override
98111
public Adapter<?, ?> get(final Object key) {
99112
final Adapter<?, ?> found = super.get(key);
@@ -153,10 +166,10 @@ public Set<AdapterKey> adapterKeys() {
153166
if (from == String.class) {
154167
return add(key, new ConverterAdapter<>(new StringConverter(), String.class));
155168
}
156-
if (from == BigDecimal.class) {
169+
if (from == BigDecimal.class && useBigDecimalStringAdapter) {
157170
return add(key, new ConverterAdapter<>(new BigDecimalConverter(), BigDecimal.class));
158171
}
159-
if (from == BigInteger.class) {
172+
if (from == BigInteger.class && useBigIntegerStringAdapter) {
160173
return add(key, new ConverterAdapter<>(new BigIntegerConverter(), BigInteger.class));
161174
}
162175
if (from == Locale.class) {

‎johnzon-mapper/src/test/java/org/apache/johnzon/mapper/LiteralTest.java‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,10 +55,13 @@ public int compare(final String o1, final String o2) {
5555
return expectedJson.indexOf(o1) - expectedJson.indexOf(o2);
5656
}
5757
};
58-
new MapperBuilder().setAttributeOrder(attributeOrder).build().writeObject(nc, sw);
58+
new MapperBuilder().setAttributeOrder(attributeOrder)
59+
.setUseBigDecimalStringAdapter(false).setUseBigIntegerStringAdapter(false)
60+
.build().writeObject(nc, sw);
5961
assertEquals(expectedJson, sw.toString());
60-
final NumberClass read = new MapperBuilder().setAttributeOrder(attributeOrder).build()
61-
.readObject(new StringReader(sw.toString()), NumberClass.class);
62+
final NumberClass read = new MapperBuilder().setAttributeOrder(attributeOrder)
63+
.setUseBigDecimalStringAdapter(false).setUseBigIntegerStringAdapter(false)
64+
.build().readObject(new StringReader(sw.toString()), NumberClass.class);
6265
assertEquals(nc, read);
6366

6467
}

‎johnzon-mapper/src/test/java/org/apache/johnzon/mapper/MapperEnhancedTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ public void writeTestclass() {
137137
public int compare(String o1, String o2) {
138138
return json.indexOf(o1) - json.indexOf(o2);
139139
}
140-
}).build().writeObject(tc2, sw);
140+
}).setUseBigDecimalStringAdapter(false).build().writeObject(tc2, sw);
141141
assertEquals(json, sw.toString());
142142
}
143143

‎johnzon-mapper/src/test/java/org/apache/johnzon/mapper/NumberSerializationTest.java‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,16 @@
1919
package org.apache.johnzon.mapper;
2020

2121
import static org.junit.Assert.assertEquals;
22+
import static org.junit.Assert.assertNotNull;
23+
import static org.junit.Assert.assertNull;
2224
import static org.junit.Assert.assertTrue;
2325

2426
import java.math.BigDecimal;
27+
import java.math.BigInteger;
2528

29+
import org.apache.johnzon.mapper.converter.BigDecimalConverter;
30+
import org.apache.johnzon.mapper.internal.AdapterKey;
31+
import org.apache.johnzon.mapper.map.LazyConverterMap;
2632
import org.junit.Test;
2733

2834
public class NumberSerializationTest {
@@ -46,11 +52,91 @@ public void numberFromJson() {
4652
mapper.close();
4753
}
4854

55+
/**
56+
* Bug: BigDecimalConverter used toString() which produces scientific notation
57+
* (e.g. "7.33915E-7"). Should use toPlainString() to produce "0.000000733915".
58+
*/
59+
@Test
60+
public void bigDecimalConverterUsesPlainNotation() {
61+
final BigDecimalConverter converter = new BigDecimalConverter();
62+
final BigDecimal smallValue = new BigDecimal("0.000000733915");
63+
final String result = converter.toString(smallValue);
64+
assertEquals("BigDecimalConverter should use plain notation, not scientific",
65+
"0.000000733915", result);
66+
}
67+
68+
/**
69+
* Bug fix: useBigDecimalStringAdapter and useBigIntegerStringAdapter flags
70+
* were swapped in LazyConverterMap. Each flag must control its own type.
71+
* Both default to true (string) for I-JSON (RFC 7493) interoperability.
72+
*/
73+
@Test
74+
public void bigDecimalStringAdapterFlagControlsBigDecimal() {
75+
// Default: BigDecimal adapter is ON (useBigDecimalStringAdapter=true)
76+
final LazyConverterMap defaultAdapters = new LazyConverterMap();
77+
assertNotNull("BigDecimal adapter should be active by default",
78+
defaultAdapters.get(new AdapterKey(BigDecimal.class, String.class)));
79+
// Disabled: BigDecimal adapter is OFF
80+
final LazyConverterMap disabledAdapters = new LazyConverterMap();
81+
disabledAdapters.setUseBigDecimalStringAdapter(false);
82+
assertNull("BigDecimal adapter should be null when flag is false",
83+
disabledAdapters.get(new AdapterKey(BigDecimal.class, String.class)));
84+
}
85+
86+
@Test
87+
public void bigIntegerStringAdapterFlagControlsBigInteger() {
88+
// Default: BigInteger adapter is ON (useBigIntegerStringAdapter=true)
89+
final LazyConverterMap adapters = new LazyConverterMap();
90+
assertNotNull("BigInteger adapter should be active by default",
91+
adapters.get(new AdapterKey(BigInteger.class, String.class)));
92+
// Disabled: BigInteger adapter is OFF
93+
final LazyConverterMap adapters2 = new LazyConverterMap();
94+
adapters2.setUseBigIntegerStringAdapter(false);
95+
assertNull("BigInteger adapter should be null when flag is false",
96+
adapters2.get(new AdapterKey(BigInteger.class, String.class)));
97+
}
98+
99+
/**
100+
* With useBigDecimalStringAdapter=true (default), BigDecimal fields
101+
* should be serialized as JSON strings using plain notation.
102+
*/
103+
@Test
104+
public void bigDecimalDefaultSerializesAsString() {
105+
try (final Mapper mapper = new MapperBuilder().build()) {
106+
final BigDecimalHolder holder = new BigDecimalHolder();
107+
holder.score = new BigDecimal("0.000000733915");
108+
final String json = mapper.writeObjectAsString(holder);
109+
// Default: BigDecimal as string with plain notation (I-JSON interoperability)
110+
assertEquals("{\"score\":\"0.000000733915\"}", json);
111+
}
112+
}
113+
114+
/**
115+
* With useBigDecimalStringAdapter=false, BigDecimal fields should be
116+
* serialized as JSON numbers (strict JSON-B 3.0 / TCK compliance).
117+
*/
118+
@Test
119+
public void bigDecimalWithAdapterDisabledSerializesAsNumber() {
120+
try (final Mapper mapper = new MapperBuilder()
121+
.setUseBigDecimalStringAdapter(false)
122+
.build()) {
123+
final BigDecimalHolder holder = new BigDecimalHolder();
124+
holder.score = new BigDecimal("0.000000733915");
125+
final String json = mapper.writeObjectAsString(holder);
126+
// Adapter disabled: BigDecimal as JSON number (scientific notation is valid per RFC 8259)
127+
assertEquals("{\"score\":7.33915E-7}", json);
128+
}
129+
}
130+
49131
public static class Holder {
50132
public long value;
51133
}
52134

53135
public static class Num {
54136
public Number value;
55137
}
138+
139+
public static class BigDecimalHolder {
140+
public BigDecimal score;
141+
}
56142
}

0 commit comments

Comments
 (0)